get /vms/{vmId}

Describe Managed VM (getManagedVms)

Describes the managed VM.

Path parameters

vmId (required)

Path Parameter — Virtual machine ID

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Return type

ManagedVmDescription

target (optional)

CloudVmInfo

errorDetails (optional)

StringToObjectMap

id (optional)

String Cloud VM ID

powerState (optional)

PowerState

VM state, for example, Starting or Running

privateIpAddress (optional)

String Cloud VM physical IP address

subnetId (optional)

String Cloud VM subnet ID

instanceType (optional)

InstanceType

VM instance type

cpus (optional)

Integer Instance Type Number of CPUs format: int32

maxDataDiskCount (optional)

Integer Instance Maximum Number of Data Disks format: int32

memory (optional)

Double VM Instance Memory Size format: double

name (optional)

String VM Instance Name

resourceDiskSize (optional)

Double VM Instance Resource Disk Size format: double

_type

String Cloud VM AWS or Azure

 

Enum:

AwsInstanceInfo

AzureVmInfo

GcpVmInfo

origin (optional)

OriginDescription

Origin Virtual Machine Description

entityId (optional)

String

cloudDetailsName (optional)

String Cloud Details name, if exists

 

stateInfo (optional)

VmStateDescription

cloudExtensionId (optional)

CloudExtensionId

cloudInstanceState (optional)

CloudInstanceState

preferredEdgeNode (optional)

EdgeNode

actualEdgeNode (optional)

EdgeNode

instanceUuid (optional)

String VM instance UUID

migrationState (optional)

MigrationState

runMode (optional)

RunMode

isSpot (optional)

Boolean Is the VM a spot VM or not

state (optional)

ManagedVmState

activeTasks (optional)

array[TaskId] Active tasks on the VM

uncommittedWrites (optional)

integer Uncommited writes format: int64

uncommittedWritesLastSync (optional)

String Uncommited writes last sync date and time format: date-time

storagePolicy (optional)

StoragePolicy

vmImporter (optional)

VmImporter

vmExporter (optional)

VmExporter

_type

String Vm state description type - instance Vm or Container

 

Enum:

VmInstanceStateDescription

PublishedVmDescription

operationLinks (optional)

OperationLink

List of Links to CE Operations

OperationLinks

array[OperationLink] (optional)

 

Example data

Content-Type: application/json

{

"target": {

"id": "string",

"powerState": "Starting",

"privateIpAddress": "10.10.20.20",

"subnetId": "subnet-1234657",

"instanceType": {

"cpus": 1,

"maxDataDiskCount": 1,

"memory": 1,

"name": "t2.micro",

"resourceDiskSize": 0

},

"_type": "AwsInstanceInfo"

},

"origin": {

"entityId": "string"

},

"stateInfo": {

"cloudExtension": {

"value": "vm-1",

"_type": "CloudExtensionId"

},

"cloudInstanceState": "None",

"edgeNode": "NodeA",

"id": {

"value": "vm-1",

"_type": "VmId"

},

"instanceUuid": "123e4567-e89b-12d3-a456-426655440000",

"migrationState": "None",

"runMode": "Normal",

"isSpot": false,

"state": "Unmanaged",

"activeTasks": [

{

"value": "vm-1",

"_type": "TaskId"

}

],

"uncommittedWrites": 0,

"uncommittedWritesLastSync": "2017-06-14T23:13:35.828Z",

"storagePolicy": "Writeback",

"vmImporter": {

"instanceId": "i-123456789",

"managedVmId": {

"value": "vm-1",

"_type": "VmId"

},

"status": "Creating",

"_type": "VmImporter"

},

"vmExporter": {

"instanceId": "i-123456789",

"managedVmId": {

"value": "vm-1",

"_type": "VmId"

},

"status": "Creating",

"_type": "VmExporter"

},

"_type": "ManagedVmDescription"

}

"OperationLinks" : [ {

"rel: "start","

"href: "/velostrata/api/v35/vms/vm-1/operations/start"

"httpVerb: "POST"

},

{

"rel: "stop","

"href: "/velostrata/api/vms/vm-1/operations/stop"

"httpVerb: "POST"

},

{

"rel: "return","

"href: "/velostrata/api/v35/vms/vm-1/operations/return"

"httpVerb: "POST"

},

{

"rel: "reboot","

"href: "/velostrata/api/v35/vms/vm-1/operations/reboot"

"httpVerb: "POST"

},

{

"rel: "allowedTasks","

"href: "/velostrata/api/v35/vms/vm-1/allowedTasks"

"httpVerb: "POST"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK ManagedVmDescription

Default

Error ErrorInfo

errorCode (optional)

String

url(optional)

String

message (optional)

String